package com.heima.common.swagger;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2//开启Swagger2接口文档
@EnableKnife4j//开启Knife4j接口文档
//导入Springfox的参数校验插件配置类，使Swagger文档能够自动显示参数的校验规则
@Import(BeanValidatorPluginsConfiguration.class)
//主要功能是配置Swagger2和Knife4j，为Spring Boot应用生成详细的RESTful接口文档
public class Swagger2Configuration {

    //定义了一个名为"defaultApi2"的Spring Bean，返回一个Docket对象
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        //置Docket对象的API信息，包括标题、描述、版本等
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //为生成的API文档指定分组名称，这里设置为"1.0"
                .groupName("1.0")
                .select()
                //指定哪些包里的Controller需要生成API文档，这里是"com.heima"包及其子包
                .apis(RequestHandlerSelectors.basePackage("com.heima"))
                //指定哪些路径需要生成API文档，这里设置为所有路径
                .paths(PathSelectors.any())
                //构建Docket对象
                .build();
        return docket;
    }

    //定义一个私有方法，用于构建并返回API的信息
    private ApiInfo apiInfo() {
        //使用ApiInfoBuilder类来构建API信息
        return new ApiInfoBuilder()
                //设置API文档的标题为"灵犀资讯API文档"
                .title("灵犀资讯API文档")
                //设置API文档的描述为"灵犀资讯API文档"
                .description("灵犀资讯API文档")
                //设置API文档的版本为"1.0"
                .version("1.0")
                //构建并返回ApiInfo对象
                .build();
    }
}